Removes the desktop database. Unless you are manipulating the desktop database in the absence of the Finder, you should never use this function. This function runs synchronously.

OSErr PBDTDeleteSync (
    DTPBPtr paramBlock
);

paramBlock

A pointer to a desktop parameter block.

function result

A result code.

DISCUSSION

Clear all fields (other than input fields) in the parameter block that you pass to Desktop Manager functions. The relevant fields of the parameter block for this function are:

• ioCompletionOn input, a universal procedure pointer to a completion function. A value of type IOCompletionUPP.
• ioResultOn return, the result code of the function. A value of type OSErr.
• ioVRefNumOn input, the volume reference number of the desktop database. A value of type SInt16.
• ioIndexOn input, reserved; must be set to 0. A value of type SInt16.

The PBDTDelete function removes the desktop database from a local volume. You can call PBDTDelete only when the database is closed.

Your application should not call PBDTDelete unless absolutely necessary.

SPECIAL CONSIDERATIONS

All of the Desktop Manager functions may move or purge memory blocks in the application heap or for some other reason should not be called from within an interrupt. Your application should not call Desktop Manager functions at interrupt time.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.

© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)